<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>ProvCon.dbui.orm.record</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="ProvCon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >docsis-provisioning</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="ProvCon-module.html">Package&nbsp;ProvCon</a> ::
        <a href="ProvCon.dbui-module.html">Package&nbsp;dbui</a> ::
        <a href="ProvCon.dbui.orm-module.html">Package&nbsp;orm</a> ::
        Module&nbsp;record
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="ProvCon.dbui.orm.record-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module record</h1><p class="nomargin-top"><span class="codelink"><a href="ProvCon.dbui.orm.record-pysrc.html">source&nbsp;code</a></span></p>
<p>The heart of the database abstraction layer. It defines the <a 
  href="ProvCon.dbui.orm.record.Record-class.html" class="link">Record</a> 
  class which represents the database at the table row level.</p>
  <p>The Record objects are designed to work with tables of a very specific
  structure. Current implementation involves heavy usage of PostgreSQL 
  features such as table-inheritance and <code>SELECT ... FROM ONLY 
  ...</code> .</p>
  <p>The assumptions may be roughly summarized as follows:</p>
  <ol start="1">
    <li>
      All tables are subtables (subclasses, descendants) of a table named 
      <code>object</code> with this signature:
      <ul>
        <li>
          objectid : int8 PRIMARY KEY
        </li>
        <li>
          objecttype : varchar (<i>name of the actual table</i>)
        </li>
        <li>
          objectcreation, objectmodification : timestamp
        </li>
        <li>
          objectscope : int2
        </li>
      </ul>
    </li>
    <li>
      All foreign keys reference the <code>objectid</code> column in the 
      referenced table.
    </li>
    <li>
      Multiple-column references are not supported (simplicity).
    </li>
  </ol>
  <p><i>for more specific information on the database structure refer to 
  the database docs</i></p>
  <h1 class="heading">Usage</h1>
    <p>Recommended usage pattern of the Record class:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>newRecord = Record.EMPTY ( <span class="py-string">&quot;customer&quot;</span> )
<span class="py-prompt">&gt;&gt;&gt; </span>newRecord.objectid
<span class="py-output">None</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>newRecord.email = <span class="py-string">&quot;customer@server.com&quot;</span>
<span class="py-prompt">&gt;&gt;&gt; </span>newRecord.telephone = <span class="py-string">&quot;001 123 445 444&quot;</span>
<span class="py-prompt">&gt;&gt;&gt; </span>newRecord.write()
<span class="py-prompt">&gt;&gt;&gt; </span>newRecord.objectid
<span class="py-output">1554</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord = Record.ID ( 1554 )
<span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.ofTable ( <span class="py-string">&quot;customer&quot;</span> )
<span class="py-output">True</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.email = <span class="py-string">&quot;customer@customers.com&quot;</span>
<span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.isModified
<span class="py-output">True</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.email
<span class="py-output">'customer@customers.com'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.read()
<span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.isModified
<span class="py-output">False</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.email
<span class="py-output">'customer@server.com'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.setObjectID(1667)
<span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.email
<span class="py-output">'othercustomer@server.com'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>oldRecord.delete()</pre>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="ProvCon.dbui.orm.record.Record-class.html" class="summary-name">Record</a><br />
      A single row in the database.
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__revision__"></a><span class="summary-name">__revision__</span> = <code title="'$Revision: 76 $'"><code class="variable-quote">'</code><code class="variable-string">$Revision: 76 $</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'ProvCon.dbui.orm'"><code class="variable-quote">'</code><code class="variable-string">ProvCon.dbui.orm</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="ProvCon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >docsis-provisioning</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Jan 13 12:48:43 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
